Lint Markdown prose with Vale - #3127
Merged
Merged
Conversation
Extend the ClearProse em dash ban from reStructuredText to Markdown, so the rule covers all our prose rather than only Sphinx documentation. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
adamtheturtle
temporarily deployed
to
development
August 7, 2026 06:04 — with 
GitHub Actions
Inactive
GitHub Actions
Inactive
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up to the change that banned em dashes in reStructuredText.
.rstwas the wrong boundary: it came from the shape of the original vws-python change, not from where our prose lives. Markdown is prose too, and nothing was checking it. Vale now lints both ([*.{rst,md}]), and thevalehook gainsmarkdownto itstypes_orwhilevale syncre-runs for.mdchanges as well.No prose changes were needed here; the existing Markdown is already clean. The value is preventive, and it makes the rule consistent across every repository that has this hook.
Verified locally: Vale reports no alerts over the tracked
.rstand.mdfiles, andprek runover the changed files passes.🤖 Generated with Claude Code
Note
Low Risk
Config-only change to dev hooks; no runtime, auth, or data paths affected.
Overview
Extends the existing ClearProse / Vale setup so Markdown gets the same prose rules (for example no em dashes) as reStructuredText, instead of only
.rstfiles.In
.vale.ini, the scope moves from[*.rst]to[*.{rst,md}]. In.pre-commit-config.yaml, thevalehook now includesmarkdownintypes_or, andvale syncalso runs when.mdfiles change via an updatedfilespattern. Comments are updated to describe both formats.Reviewed by Cursor Bugbot for commit 6e698d4. Bugbot is set up for automated code reviews on this repo. Configure here.